Skip to content

docs: Correct link targets and line highlights #390

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 3 commits into from
Apr 9, 2021
Merged

docs: Correct link targets and line highlights #390

merged 3 commits into from
Apr 9, 2021

Conversation

michaelbrewer
Copy link
Contributor

@michaelbrewer michaelbrewer commented Apr 9, 2021 •
edited
Loading

Issue #, if available:

Description of changes:

Changes:

  • Use target _blank for external links
  • Correct some of the line highlighted in the examples
  • Fix links to Tracer

Checklist

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@michaelbrewer
docs: Correct links and line highlights
9a66b6e 
Changes:
- Use target _blank for external links
- Correct some of the line highlighted in the examples
- Fix links to Tracer
heitorlessa
heitorlessa suggested changes Apr 9, 2021
View reviewed changes
Copy link
Contributor

@heitorlessa heitorlessa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two minor changes before I merge - Revert one change (relative is safer) and add .md suffix to a previously broken link

docs/utilities/middleware_factory.md Outdated
@@ -60,7 +60,7 @@ You can also have your own keyword arguments after the mandatory arguments.

## Tracing middleware execution

If you are making use of [Tracer](../core/tracer.md), you can trace the execution of your middleware to ease operations.
If you are making use of [Tracer](/core/tracer), you can trace the execution of your middleware to ease operations.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please revert these. I've just tested and MKdocs correctly builds internal links as they should.

image

@michaelbrewer
Copy link
Contributor Author

Two minor changes before I merge - Revert one change (relative is safer) and add .md suffix to a previously broken link

Ok, but during local testing i get a 404?

@heitorlessa
Copy link
Contributor

Working for me locally using both make docs-local and make docs-local-docker

What breaks is the second link because it doesn't have a .md, so MKdocs can't construct the correct internal link based on the official docs

image

image

then fixing with the correct .md:

When executed, your middleware name will [appear in AWS X-Ray Trace details as](../core/tracer.md) `## middleware_name`.

For advanced use cases, you can instantiate [Tracer](../core/tracer.md) inside your middleware, and add annotations as well as metadata for additional operational insights.

image

@michaelbrewer
Copy link
Contributor Author

Working for me locally using both make docs-local and make docs-local-docker

What breaks is the second link because it doesn't have a .md, so MKdocs can't construct the correct internal link based on the official docs

image

image

then fixing with the correct .md:


When executed, your middleware name will [appear in AWS X-Ray Trace details as](../core/tracer.md) `## middleware_name`.



For advanced use cases, you can instantiate [Tracer](../core/tracer.md) inside your middleware, and add annotations as well as metadata for additional operational insights.

image

Sweet. I will try again

@michaelbrewer
Copy link
Contributor Author

@heitorlessa ok i updated it.

@heitorlessa heitorlessa added the documentation Improvements or additions to documentation label Apr 9, 2021
@heitorlessa heitorlessa changed the title docs: Correct links and line highlights docs: Correct link targets and line highlights Apr 9, 2021
@heitorlessa heitorlessa self-assigned this Apr 9, 2021
@michaelbrewer
Copy link
Contributor Author

@heitorlessa Note, we now have an issue for the link to the missing Event handler page:

| [Event handler](./core/event_handler) | Event handler decorators for common Lambda events

@codecov-io
Copy link

Codecov Report

Merging #390 (7fdff56) into develop (48ffc2a) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff            @@
##           develop     #390   +/-   ##
========================================
  Coverage    99.94%   99.94%           
========================================
  Files           98       98           
  Lines         3688     3688           
  Branches       174      174           
========================================
  Hits          3686     3686           
  Partials         2        2

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 48ffc2a...7fdff56. Read the comment docs.

@heitorlessa heitorlessa merged commit 0edec8e into aws-powertools:develop Apr 9, 2021
@michaelbrewer michaelbrewer deleted the docs-links-hlights branch April 9, 2021 07:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@heitorlessa heitorlessa Awaiting requested review from heitorlessa

Assignees

@heitorlessa heitorlessa

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@michaelbrewer @heitorlessa @codecov-io